Type: object

root directory
Type: object

this section contains directory api configuration

 No Additional Properties

root directory directory_api_local_port
Type: integer

Local bind port used by the ∞Directory api implementation

Value must be greater or equal to 1 and lesser or equal to 65535

root directory directory_public_url
Type: string

Public url of the ∞Directory. should be accessible by clients and backend nodes

Must match regular expression: ^https:\/\/[^@]+?(:[0-9]+)?(\/.*)?\/directory

root general
Type: object

this section contains general install parameters

 No Additional Properties

root general binary_basepath
Type: string or null

(Windows only) Base folder were all software binaries will be installed if not overloaded by optional settings

root general http_proxy
Type: string or null

Define which http proxy should be used during installation

Must match regular expression: ^http[s]?:\/\/.*

root general https_proxy
Type: string or null

Define which https proxy should be used during installation

Must match regular expression: ^http[s]?:\/\/.*

root general install_basepath
Type: string

Base folder that will contain db and services data

Must be at least 1 characters long

root general loki_post_url
Type: string or null

Loki url on which service logs will be posted. POST body will gziped json as described in Grafana Loki push specification https://grafana.com/docs/loki/latest/api/#post-lokiapiv1push

Must match regular expression: ^http[s]?:\/\/.*

root general provided_certificate_file
Type: string or null

Certificate file for this server, if empty a self signed certificate will be generated. Note that this certificate will be copied locally

root general provided_privatekey_file
Type: string or null

Private key associated to the server certificate file, if empty a self signed certificate will be generated. Note that this certificate will be copied locally

root general realfusio_apt
Type: string or null

(Linux only) Url of apt repository, please contact your provider to get one

root general verify_ssl_peer
Type: boolean

Set this value to true and all connections between the servers (∞Directory, ∞Server, ∞Proxy, ∞StaticProxy) will check the legitimity/validity of the TLS certificate during connections. Invalid certificates will prevent these elements from communicating. You will need to include the IPv4 address and the hostname of the server in each certificate. DANGER Invalid certificates will prevent elements from communicating.

root inferred
Type: object

inferred values

 No Additional Properties

root inferred apache_empty_root_folder
Type: string

Folder that will contain no files (Defaults to : ${install_basepath}/current/www/empty) /!\ all files from this folder will be freely downloadable

Must be at least 1 characters long

root inferred apache_folder
Type: string

(Windows only) Folder where the 3DJuump Infinite Apache Lounge binaries will be installed (Defaults to : ${binary_basepath}/Apache)

Must be at least 1 characters long

root inferred apache_log_folder
Type: string

Folder that will contain the Apache access and error logs (Defaults to : ${install_basepath}/current/www/logs)

Must be at least 1 characters long

root inferred auth_pwd_file
Type: string

Must be at least 1 characters long

root inferred directory_binary_folder
Type: string

(Windows only) Folder where the ∞Directory service binaries will be installed (Defaults to : ${binary_basepath}/3DJuumpInfiniteDirectoryx64)

Must be at least 1 characters long

root inferred directory_log_folder
Type: string

Folder that will contain the ∞Directory service log files (Defaults to : ${install_basepath}/current/service/logs)

Must be at least 1 characters long

root inferred elastic_binary_folder
Type: string

(Windows only) Folder where the ElasticSearch binaries will be installed (Defaults to : ${binary_basepath}/ElasticSearch)

Must be at least 1 characters long

root inferred elastic_data_folder
Type: string

Folder that will contain the ElasticSearch node data (Defaults to : ${install_basepath}/current/elasticsearch/data)

Must be at least 1 characters long

root inferred elastic_log_folder
Type: string

Folder that will contain the ElasticSearch log files (Defaults to : ${install_basepath}/current/elasticsearch/logs)

Must be at least 1 characters long

root inferred infinite_postgres_plugins_folder
Type: string

(Windows only) Folder where the 3D Juump Infinite Postgres Plugins binaries will be installed (Defaults to : ${binary_basepath}/3DJuumpInfinitePostgresPluginsx64)

Must be at least 1 characters long

root inferred java_binary_folder
Type: string

(Windows only) Folder where the Java binaries will be installed (Defaults to : ${binary_basepath}/Java)

Must be at least 1 characters long

root inferred postgres_data_folder
Type: string

Folder that will contain the PostgreSQL cluster data (Defaults to : ${install_basepath}/current/postgresql)

Must be at least 1 characters long

root inferred postgres_folder
Type: string

(Windows only) Folder where the PostgreSQL binaries will be installed (Defaults to : ${binary_basepath}/PostgreSQL)

Must be at least 1 characters long

root inferred proxy_binary_folder
Type: string

Folder where the ∞Proxy/∞Server service binaries will be installed (Defaults to : ${binary_basepath}/3DJuumpInfiniteServerx64)

Must be at least 1 characters long

root inferred proxy_data_folder
Type: string

Folder that will contain the 3d data of the ∞Proxy/∞Server service (Defaults to : ${install_basepath}/current/service/3d)

Must be at least 1 characters long

root inferred proxy_eseditor_folder
Type: string

Folder that will contain the eseditor files (Defaults to : ${install_basepath}/current/www/eseditor) /!\ all files from this folder will be freely downloadable from https://hostname:https_port/myprefix/eseditor uri

Must be at least 1 characters long

root inferred proxy_log_folder
Type: string

Folder that will contain the ∞Proxy/∞Server service log files (Defaults to : ${install_basepath}/current/service/logs)

Must be at least 1 characters long

root inferred ssl_folder
Type: string

Folder that will contain autogenerated certificat except if a specific one is specified (Defaults to : ${install_basepath}/ssl)

Must be at least 1 characters long

root lmx
Type: object

define optional lmx configuration

 No Additional Properties

root lmx lmx_feature
Type: string or null

LMX Directory feature that should be used by this ∞Directory to allow borrow, please contact your provider to get one

root lmx lmx_server
Type: string or null

Connection information to reach the LMX server, in LMX format.

root openidconnect
Type: object
No Additional Properties

root openidconnect additional_query_parameters
Type: object
No Additional Properties

root openidconnect additional_query_parameters authorization_endpoint
Type: object

Each additional property must conform to the following schema

root openidconnect additional_query_parameters authorization_endpoint additionalProperties
Type: string

root openidconnect additional_query_parameters jwks_uri
Type: object

Each additional property must conform to the following schema

root openidconnect additional_query_parameters jwks_uri additionalProperties
Type: string

root openidconnect additional_query_parameters revocation_endpoint
Type: object

Each additional property must conform to the following schema

root openidconnect additional_query_parameters revocation_endpoint additionalProperties
Type: string

root openidconnect additional_query_parameters token_endpoint
Type: object

Each additional property must conform to the following schema

root openidconnect additional_query_parameters token_endpoint additionalProperties
Type: string

root openidconnect additional_scopes
Type: object
No Additional Properties

root openidconnect additional_scopes client_token
Type: string Default: ""

root openidconnect additional_scopes primo_token
Type: string Default: ""

root openidconnect allowed_jwt_alg
Type: array of enum (of string) Default: ["RS256"]
No Additional Items

Each item of this array must be:

root openidconnect allowed_jwt_alg allowed_jwt_alg items
Type: enum (of string)

Must be one of:

  • "HS256"
  • "HS384"
  • "HS512"
  • "RS256"
  • "RS384"
  • "RS512"
  • "EC256"
  • "EC384"
  • "EC521"

root openidconnect authentication_webhook

root openidconnect authentication_webhook oneOf item 0
Type: null
root openidconnect authentication_webhook oneOf item 1
Type: object
No Additional Properties

root openidconnect authentication_webhook oneOf item 1 url
Type: string
Must match regular expression: ^https:\/\/.*$

root openidconnect client_id
Type: string

Must be at least 1 characters long

root openidconnect client_secret
Type: string

Must be at least 1 characters long

root openidconnect configuration_endpoint
Type: string
Must match regular expression: ^https:\/\/.*$

root openidconnect hmac_secret

root openidconnect hmac_secret oneOf item 0
Type: null
root openidconnect hmac_secret oneOf item 1
Type: string

Must be at least 0 characters long

root openidconnect http_proxy

root openidconnect http_proxy oneOf item 0
Type: string
Must match regular expression: ^http[s]?:\/\/.*$
root openidconnect http_proxy oneOf item 1
Type: null
root openidconnect http_proxy oneOf item 2
Type: enum (of boolean)

Must be one of:

  • false
root openidconnect http_proxy oneOf item 3
Type: enum (of boolean)

Must be one of:

  • true

root openidconnect id_token_alias
Type: object

Each additional property must conform to the following schema

root openidconnect id_token_alias additionalProperties
Type: string

Must be at least 1 characters long

root openidconnect jwks_uri
Type: string Default: ""

provide this if configurationendpoint will not be reachable during install. should contain "jwksuri" returned by configuration_endpoint

root openidconnect oidc_access_token_aud
Type: string Default: ""

root openidconnect use_PKCE
Type: boolean Default: true

root openidconnect use_oidc_access_token
Type: boolean Default: true

root openidconnect user_unique_id
Type: enum (of string) Default: "oidc"

Must be one of:

  • "oidc"
  • "email"
  • "azureoid"

root openidconnect verify_ssl_peer
Type: boolean Default: true

root postgres
Type: object

Define local postgres configuration

 No Additional Properties

root postgres postgres_login
Type: string

Postgres login for super user role used by the Infinite services to login to the PostgreSQL cluster

Must be at least 1 characters long

root postgres postgres_password
Type: string

Postgres password for super user role used by the Infinite services to login to the PostgreSQL cluster /!\ this password should be strong, and should not any contain blank characters.

Must be at least 1 characters long

root postgres postgres_port
Type: integer

Port number of PostgreSQL service

Value must be greater or equal to 1 and lesser or equal to 65535

root proxy
Type: object

this section contains proxy api configuration

 No Additional Properties

root proxy elastic_port
Type: integer

Port number of ElasticSearch service

Value must be greater or equal to 1 and lesser or equal to 65535

root proxy generate_web_data
Type: boolean

Set this variable to true to configure the ∞Server/∞Proxy as a data provider for the web api

root proxy linux_oracle_java
Type: boolean

(Linux only) Elasticsearch depends on Java. On Linux, there are 2 viable options to get java : OpenJDK (https://openjdk.java.net/) and Oracle Java (https://www.oracle.com/technetwork/java/index.html). Set this variable to true to use the Oracle version, but you will have to install it manually, and accept the Oracle Java terms and conditions during the installation.

root proxy proxy_api_local_port
Type: integer

Local bind port used by the ∞Proxy/∞Server api implementation

Value must be greater or equal to 1 and lesser or equal to 65535

root proxy proxy_public_url
Type: string

Public url of the ∞Proxy/∞Server. should be accessible by clients

Must match regular expression: ^https:\/\/[^@]+?(:[0-9]+)?(\/.*)?\/proxy

root proxy proxy_role
Type: enum (of string)

Type of ∞Proxy/∞Server you want to install

Must be one of:

  • "server"
  • "dynamic"
  • "static"